Sprite 1984 - 1993/Sprite 1984 - 1993.iso/src/cmds/rpcstat/RCS/rpcstat.man,v

Text File | 1992-07-10 | 8.1 KB | 368 lines

head     1.8;
branch   ;
access   ;
symbols  ;
locks    ; strict;
comment  @@;


1.8
date     92.07.10.15.26.27;  author kupfer;  state Exp;
branches ;
next     1.7;

1.7
date     92.07.10.15.17.39;  author kupfer;  state Exp;
branches ;
next     1.6;

1.6
date     90.12.06.10.40.30;  author mendel;  state Exp;
branches ;
next     1.5;

1.5
date     89.06.23.15.49.59;  author brent;  state Exp;
branches ;
next     1.4;

1.4
date     89.06.23.13.37.40;  author brent;  state Exp;
branches ;
next     1.3;

1.3
date     88.12.30.10.13.02;  author ouster;  state Exp;
branches ;
next     1.2;

1.2
date     88.12.22.11.38.21;  author ouster;  state Exp;
branches ;
next     1.1;

1.1
date     88.11.08.15.37.07;  author brent;  state Exp;
branches ;
next     ;


desc
@Man page for the rpcstat command
@


1.8
log
@Start a BUGS section: note that many buckets will always have a count
of 0 because of the coarse system clock resolution.
@
text
@' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.7 92/07/10 15:17:39 kupfer Exp Locker: kupfer $ SPRITE (Berkeley)
.so \*(]ltmac.sprite
.HS RPCSTAT cmds
.BS
.SH NAME
rpcstat \- Print out statistics about the RPC system
.SH SYNOPSIS
\fBrpcstat\fR  [\fIoptions\fR]
.SH OPTIONS
.IP "\fB\-trace\fR" 14
Print out the RPC trace.
.IP "\fB\-cinfo\fR"
Print client-side RPC system statistics.
.IP "\fB\-sinfo\fP"
Print server-side RPC system statistics.
.IP "\fB\-chan\fP"
Print the state of the client RPC channels.
.IP "\fB\-srvr\fP"
Print the state of the RPC server processees.
.IP "\fB\-calls\fP"
Print the number of RPC calls made.
.IP "\fB\-rpcs\fP"
Print the number of RPC calls serviced.
.IP "\fB\-chist\fP"
Display the client-side RPC histograms.
.IP "\fB\-shist\fP"
Display the server-side RPC histograms.
.IP "\fB\-zero\fP"
Print the zero valued counts.
.IP "\fB\-nohostdb\fP"
Do not search the host database file.
.BE
.SH INTRODUCTION
This command is used to get statistics and trace information about the
Sprite kernel-to-kernel RPC system.
.SH "RPC TRACE"
.PP
The RPC trace has a record for the
last 100 packets sent or received in the RPC network protocol.  The trace
has the following fields:
.DS
\fBID code time flag commnd client server psize dsize doff fragment\fR
.DE
.IP \fBID\fR 10
The RPC sequence number.  A new ID is generated for each RPC, and
all packets involved with an RPC contain this ID.
.IP \fBcode\fR 10
Either "in" or "out" to mean the packet was transmitted or received.
.IP \fBtime\fR 10
Seconds since last packet.  Sun3 clock granularity is too low (10 msec) for this
to be meaningful.
.IP \fBflag\fR 10
.DS
\fBQ\fP reQuest packet.
\fBQp\fP reQuest with please acknowledge bit set.
\fBA\fP Acknowledgment packet.
\fBR\fP Reply packet.
\fBRe\fP Error reply; command field contains error code.
\fBAc\fP Close acknowledgment sent to close client/server binding.
.DE
.IP \fBcommand\fR 10
The RPC name.  If this is a number and the flag field is "Re",
then this is the returned error code.
.IP \fBclient\fR 10
Two numbers identify the client host and the client channel number.
.IP \fBserver\fR 10
Two numbers identify the server host and the server process number.
.IP \fBpsize\fR 10
The size of the parameter area of the packet.
.IP \fBdsize\fR 10
The size of the data area of the packet
.IP \fBdoff\fR 10
The offset of the data area.  Used when fragmenting large data blocks.
.IP \fBfragment\fR 10
Two numbers are the number of fragments and the fragment bitmask.
.SH "CLIENT RPC"
.PP
The client half of the RPC system maintains statistics about the
number of timeouts, retransmissions, etc.  The output of the \fB\-cinfo\fP
option is (nearly) self-explanatory.  There are also a set of
\fIchannels\fP used by the client side of RPC.  Each channel is
dynamically bound to a particular server host/process pair, and
the kernel attempts to reuse the channel for successive RPCs to that server.
The \fB\-chan\fP option prints out the state of the client channels,
what they are bound to, what RPC is in progress, etc.
The binding is not hard, but is used to optimize away explicit
acknowledgment packets.
.SH "SERVER RPC"
.PP
The server half of the RPC system maintains statistics about the
number of requests it has received, the number of requests that
implicitly acknowledged a previous reply, etc.  The output of
the \fB\-sinfo\fP option is (nearly) self-explanatory.  There are also
a pool of kernel RPC server processes.  The \fB\-srvr\fP option
prints out the state of each, their current client, the current RPC, etc.
.SH HISTOGRAMS
.PP
The kernel can keep track of how long RPCs take.  For each RPC number
the kernel keeps the total time spent processing that RPC command, as
well as a histogram showing the distribution of times.  The
.B \-chist
option displays the client-side timings, whereas
.B \-shist
displays the server-side timings.  These options display the following
information for each RPC command: the command name, the number of
calls, the average time per call, the overhead for collecting the
timing information, and the timing distribution for the command.  The
timing distribution is a series of double lines.  The top line gives
the minimum times for a series of buckets, in microseconds, and the
bottom line gives the number of RPCs that fell into that bucket.
.PP
Use
.B rpccmd
to enable, disable, or reset these timings.
.SH BUGS
On current Sprite systems, the histogram resolution is finer than the
clock resolution, so many buckets will always have a count of 0.
.SH "SEE ALSO"
rpccmd
.SH KEYWORDS
rpc, server, client, channel
@


1.7
log
@Document histogram support.  Fix synposis line.  Fix documentation for
some options that were apparently renamed some time ago.
@
text
@d1 1
a1 1
' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.6 90/12/06 10:40:30 mendel Exp Locker: kupfer $ SPRITE (Berkeley)
d115 3
@


1.6
log
@Added the nohostdb option.
@
text
@d1 1
a1 1
' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.5 89/06/23 15:49:59 brent Exp Locker: mendel $ SPRITE (Berkeley)
d8 1
a8 1
\fBrpcstat\fR  -[\foptions\fR]
d24 4
d79 2
a80 2
number of timeouts, retransmissions, etc.  The output of the \fB\-C\fP
option is (nearly) self-explanitory.  There are also a set of
d84 1
a84 1
The \fB\-c\fP option prints out the state of the client channels,
d93 2
a94 2
the \fB\-S\fP option is (nearly) self-explanitory.  There are also
a pool of kernel RPC server processes.  The \fB\-s\fP option
d96 21
@


1.5
log
@fixed typo
@
text
@d1 1
a1 1
' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.4 89/06/23 13:37:40 brent Exp Locker: brent $ SPRITE (Berkeley)
d26 2
@


1.4
log
@Updated to handle new option formats
@
text
@d1 1
a1 1
' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.3 88/12/30 10:13:02 ouster Exp Locker: brent $ SPRITE (Berkeley)
d8 1
a8 1
\fBrpcstat\fR  -[\fBtCScs\fR]
@


1.3
log
@More format upgrades.
@
text
@d1 1
a1 1
' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.2 88/12/22 11:38:21 ouster Exp Locker: ouster $ SPRITE (Berkeley)
d10 1
a10 1
.IP "\fB\-t\fR" 14
d12 1
a12 1
.IP "\fB\-C\fR"
d14 1
a14 1
.IP "\fB\-S\fP"
d16 1
a16 1
.IP "\fB\-c\fP"
d18 1
a18 1
.IP "\fB\-s\fP"
d20 6
@


1.2
log
@Format upgrade.
@
text
@d1 1
a1 1
' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.1 88/11/08 15:37:07 brent Exp $ SPRITE (Berkeley)
d10 1
a10 1
.IP "\fB-t\fR" 14
d12 1
a12 1
.IP "\fB-C\fR"
d14 1
a14 1
.IP "\fB-S\fP"
d16 1
a16 1
.IP "\fB-c\fP"
d18 1
a18 1
.IP "\fB-s\fP"
d30 1
a30 2

ID code time flag commnd client server psize dsize doff fragment
d32 1
a32 1
.IP ID 10
d35 1
a35 1
.IP code 10
d37 1
a37 1
.IP time 10
d40 1
a40 1
.IP flag 10
d49 1
a49 1
.IP command 10
d52 1
a52 1
.IP client 10
d54 1
a54 1
.IP server 10
d56 1
a56 1
.IP psize 10
d58 1
a58 1
.IP dsize 10
d60 1
a60 1
.IP doff 10
d62 1
a62 1
.IP fragment 10
d67 1
a67 1
number of timeouts, retransmissions, etc.  The output of the \fB-C\fP
d72 1
a72 1
The \fB-c\fP option prints out the state of the client channels,
d81 2
a82 2
the \fB-S\fP option is (nearly) self-explanitory.  There are also
a pool of kernel RPC server processes.  The \fB-s\fP option
@


1.1
log
@Initial revision
@
text
@d1 3
a3 2
' $Header: /sprite/doc/ref/cmds/RCS/rpcecho,v 1.1 88/10/31 14:10:06 brent Exp $ SPRITE (Berkeley)
.TH rpcstat prog
d5 1
a5 1
.NA
d7 2
a8 2
.SY
\fBrpcstat\fR  -[tCScs]
@